Skip to main content

Set Custom Data Items

Set a data item with a given key and value for the specified custom ID. The value is limited to a maximum size of 5 MB across all default access level slots. The entire default access level saved state for a custom ID is limited to 2000 keys. Attempting to set a new key beyond this limit will result in an error. Only accessible via an authenticated server authority.

Authentication Required: Yes

ugs cloud-save data custom set [options]

Options

AliasDescription
project-id-p, --project-idThe Unity cloud project ID.
environment-e, --environment-nameThe services environment name.
custom-id--custom-idThe custom entity ID to set the data for.
key--keyThe key of the key-value pair. The key will be created if it does not exist, provided the item limit of 2000 keys has not been reached for this entity.
value--valueAny string, number, boolean, or JSON string with a maximum size of 5 MB.
writelock--writelockEnforces conflict checking when updating an existing data item. This field should be omitted when creating a new data item. When updating an existing item, omitting this field ignores write conflicts. When present, an error response will be returned if the writeLock in the request does not match the stored writeLock.
visibility--visibilityOne of 'default' or 'private'. If not set, 'default' will be used.
help-?, -h, --helpDisplay help and usage information.
quiet-q, --quietReduce logging to a minimum.
json-j, --jsonUse JSON as the output format.